<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>YUI Library Examples: ProgressBar Control: Ratings</title>
    

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >

<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
</style>

<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/logger/assets/skins/sam/logger.css" />
<link rel="stylesheet" type="text/css" href="../../build/datatable/assets/skins/sam/datatable.css" />
<link rel="stylesheet" type="text/css" href="../../build/progressbar/assets/skins/sam/progressbar.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/logger/logger-min.js"></script>
<script type="text/javascript" src="../../build/datasource/datasource-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/datatable/datatable-min.js"></script>
<script type="text/javascript" src="../../build/progressbar/progressbar-debug.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>


<!--begin custom header content for this example-->
<style type="text/css">
.yui-skin-sam .ratings {
	background: transparent url(../progressbar/assets/star-bg.png) repeat-x 0 0;
	border:0;
}
.yui-skin-sam .ratings .yui-pb-mask {
	border:0;
}
.yui-skin-sam .ratings .yui-pb-bar  {
	background: transparent url(../progressbar/assets/star.png) repeat-x 0 0;
}

/* Just a little decoration for the page, not relevant to the usage of the progress bar */

.dp-highlighter th, .dp-highlighter td {
	border:0;
	padding:0;
}
.dp-highlighter .line1, .dp-highlighter  .line2 {
	padding-left:10px;
	white-space:nowrap;
}
</style>

<!--end custom header content for this example-->


<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
	YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class="yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
	<div id="ygunav">
		<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
		<form action="http://search.yahoo.com/search" id="sitesearchform">
		<input name="vs" type="hidden" value="developer.yahoo.com">
		<input name="vs" type="hidden" value="yuiblog.com">
		<div id="sitesearch">
			<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
			<input type="text" id="searchinput" name="p">
			<input type="submit" value="Search" id="searchsubmit" class="ygbt">
		</div>
		</form>	</div>
	<div id="ygma"><a href="../../"><img src="../../assets/yui.gif"  border="0" height="38"></a></div>
	<div id="pagetitle"><h1>YUI Library Examples: ProgressBar Control: Ratings</h1></div>
</div>
<div id="bd">
	
	<div id="yui-main">
		<div class="yui-b">
		  <div class="yui-ge">
			  <div class="yui-u first example">

    
	<div class="promo">
	<h1>ProgressBar Control: Ratings</h1>
	
	<div class="exampleIntro">
	<p>The ProgressBar can be used within other widgets. Here we are using Yahoo! Query Language, <a href="http://developer.yahoo.com/yql/">YQL</a>, to find sushi restaurants in San Francisco, CA and display the information in a <a href="http://developer.yahoo.com/yui/datatable/">DataTable</a>. We are showing most of the fields as plain text, but the restaurant ratings are displayed using the ProgressBar.</p>
			
	</div>	
					
	<div class="example-container module ">
			<div class="hd exampleHd">
			<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="pb_ratings_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->		
		</div>		<div id="example-canvas" class="bd">
	
		
	<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
	
	<div id="Container"></div>

<script type="text/javascript" src="assets/YQLDataSource.js"></script>
<script type="text/javascript">
YAHOO.util.Event.onDOMReady(function () {
	YAHOO.util.Event.onDOMReady(function () {
		var pbs = [];
		var ratingFormatter = function (elLiner, oRecord, oColumn, oData) {
			var pb = new YAHOO.widget.ProgressBar({
				width:'90px',
				height:'18px',
				maxValue:5,
				className:'ratings',
				value:oData
			}).render(elLiner);
			pbs.push(pb);
		};

		var dt = new YAHOO.widget.DataTable(
			'Container',
			[
				{key:"Title",sortable:true},
				{key:"Address",sortable:true},
				{key:"Phone",sortable:true},
				{key:"Rating.AverageRating",label:"Rating",	sortable:true, formatter:ratingFormatter}
			],
			new YAHOO.util.YQLDataSource(null, {responseSchema:{fields:[{key:"Rating.AverageRating",parser:"number"}]}}),
			{
				initialRequest:'select Title,Address,Phone, Rating.AverageRating from local.search where query="sushi" and location="san francisco, ca"'
			}
		);
		dt.on('beforeRenderEvent',function() {
			for (var i = 0; i<pbs.length; i++) {
				pbs[i].destroy();
			}
			pbs = [];
		});
    });
});
</script>
	
	<!--END SOURCE CODE FOR EXAMPLE =============================== -->
	
		
		</div>
		
	
	</div>			
	</div>
		
	<p>The Rating.AverageRating values from the YQL response are displayed as YUI ProgressBars.
The YQL query for this example is:</p>
<textarea name="code" class="JScript" cols="60" rows="1">
	select Title,Address,Phone, Rating.AverageRating from local.search
		where query="sushi" and location="san francisco, ca"
</textarea>
<p>which can be tested by pasting it into the <a href="http://developer.yahoo.com/yql/console/">YQL Console</a>.
We are using <a href="../datasource/datasource_yql.html">YQLDataSource, a subclass of DataSource</a> to handle
the communication with YQL for us.</p>

<p>The code to build the DataTable on that query is:</p>
<textarea name="code" class="JScript" cols="60" rows="1">
	var dt = new YAHOO.widget.DataTable(
		'Container',
		[
			{key:"Title", sortable:true},
			{key:"Address", sortable:true},
			{key:"Phone", sortable:true},
			{key:"Rating.AverageRating", label:"Rating", formatter:ratingFormatter,	sortable:true}
		],
		new YAHOO.util.YQLDataSource(null, {responseSchema:{fields:[{key:"Rating.AverageRating",parser:"number"}]}}),
		{
			initialRequest:'select Title, Address, Phone, Rating.AverageRating from local.search where query="sushi" and location="san francisco, ca"'
		}
	);
</textarea>
<p>We create a simple DataTable with the columns Title, Address and Phone as simple
text fields that are displayed just as they are received.  A fourth column receives
data held in the nested field Rating.AverageRating. We use a custom formatter to
render ProgressBars instead of showing the plain numbers. All columns are sortable, even the Ratings column.</p>

<p>The <code>ratingFormatter</code> is the function that will create the ProgressBars:<p>
<textarea name="code" class="JScript" cols="60" rows="1">
	var pbs = [];
	var ratingFormatter = function (elLiner, oRecord, oColumn, oData) {
		var pb = new YAHOO.widget.ProgressBar({
			width:'90px',
			height:'18px',
			maxValue:5,
			className:'ratings',
			value:oData
		}).render(elLiner);
		pbs.push(pb);
	};
</textarea>
<p>The core of it is the creation of the ProgressBar 90px wide and 18px high. We
set this size because our star image is a 18-pixel square and we want to fit
up to five stars horizontally.  Five is, indeed, the <code>maxValue</code> that the rating
might reach.  We add a className <code>"ratings"</code> to the widget, which will help us with some formatting details
and, finally, we set the current value for the progressBar to the cell value.</p>

<p>Every time the DataTable is sorted or redrawn for any reason (such as call to the <code>render</code> method or paging),
the formatter function will be called again.  As with any widget, the ProgressBar might take resources that might not be
automatically cleared by the garbage collector, so it is vital to call <code>destroy</code> method to make sure all such
resources are cleared.  We store each ProgressBar instance in the array <code>pbs</code>. Before any render,
we iterate over this array and destroy every instance we have stored.</p>
<textarea name="code" class="JScript" cols="60" rows="1">
	dt.on('beforeRenderEvent',function() {
		for (var i = 0; i<pbs.length; i++) {
			pbs[i].destroy();
		}
		pbs = [];
	});
</textarea>
<p></p>

<p>We have applied the <code>yui-skin-sam</code> as a skin for all the widgets
of the page, (the DataTable and ProgressBars), so we need to
override some of these settings in order to set the stars images.
The stars come from a two images (a red star and a gray star) which are tiled to fill the allotted space.
We gave the <code>ratings</code> className to all the ProgressBars
as an argument at instantiation, so we can use <code>.yui-skin-sam .ratings</code> as a selector in our custom styles:</p>
<textarea name="code" class="CSS" cols="60" rows="1">
.yui-skin-sam .ratings {
	background: transparent url(star-bg.png) repeat-x 0 0;
	border:0;
}
.yui-skin-sam .ratings .yui-pb-mask {
	border:0;
}
.yui-skin-sam .ratings .yui-pb-bar  {
	background: transparent url(star.png) repeat-x 0 0;
}
</textarea>

<h2>Configuration for This Example</h2>

<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers.  <a href="http://developer.yahoo.com/yui/articles/hosting/?get&datasource&datatable&progressbar&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>

				</div>
				<div class="yui-u">
						<div id="loggerModule" class="yui-skin-sam">
						<h3 class="firstContent">YUI Logger Output:</h3>
								<div id="loggerDiv"></div>
							<div id="loggerGloss">
								<p><strong>Note:</strong> You are viewing this example in debug mode with logging enabled.  This can significantly slow performance.</p>
	
								<p class="loggerButton"><span id="loggerLink"><span class="first-child"><a href="pb_ratings.html">Reload with logging<br />and debugging disabled.</a></span></span></p>
							</div>
						</div>
					
				
					<div id="examples">
						<h3>ProgressBar Control Examples:</h3>
	
						<div id="exampleToc">
							<ul>
								<li><a href='../progressbar/pb_basic.html'>Basic Features</a></li><li><a href='../progressbar/pb_events.html'>Events</a></li><li class='selected'><a href='../progressbar/pb_ratings.html'>Ratings</a></li><li><a href='../progressbar/pb_vumeter.html'>VU Meters</a></li>							</ul>
						</div>
					</div>
					
					<div id="module">
						<h3>More ProgressBar Control Resources:</h3>
						<ul>
							<li><a href="http://developer.yahoo.com/yui/progressbar/">User's Guide</a> (external)</li>
						<li><a href="../../docs/module_progressbar.html">API Documentation</a></li>
                            
                            
							<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/progressbar.pdf">Cheat Sheet PDF</a> (external)</li></ul>
					</div>
			  </div>
		</div>
		
		</div>
	</div>


<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
	
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="selected "><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="item"><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
	</div><!--closes bd-->

	<div id="ft">
        <p class="first">Copyright &copy; 2010 Yahoo! Inc. All rights reserved.</p>
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
	</div>
</div>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript"> 
dp.SyntaxHighlighter.HighlightAll('code'); 
</script>

<script src='../../assets/YUIexamples.js'></script>


</body>
</html>
